Skip to content

Enums

AerialMapTileResourceType

Bases: MapTileResourceType

Type of Aerial Map Tile Resources.

Source code in herepy/here_enum.py
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
class AerialMapTileResourceType(MapTileResourceType):
    """Type of Aerial Map Tile Resources."""

    alabeltile = "alabeltile"
    basetile = "basetile"
    blinetile = "blinetile"
    labeltile = "labeltile"
    linetile = "linetile"
    lltile = "lltile"
    maptile = "maptile"
    streettile = "streettile"
    trucktile = "trucktile"
    truckonlytile = "truckonlytile"
    xbasetile = "xbasetile"
    trucknopttile = "trucknopttile"
    mapnopttile = "mapnopttile"

AvoidFeature

Bases: Enum

Enum for routing features that avoids during route calculation.

Source code in herepy/here_enum.py
500
501
502
503
504
505
506
507
508
509
510
class AvoidFeature(Enum):
    """Enum for routing features that avoids during route calculation."""

    toll_road = "tollRoad"
    controlled_access_highway = "controlledAccessHighway"
    ferry = "ferry"
    tunnel = "tunnel"
    dirt_road = "dirtRoad"

    def __str__(self):
        return "%s" % self._value_

BaseMapTileResourceType

Bases: MapTileResourceType

Type of Base Map Tile Resources.

Source code in herepy/here_enum.py
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
class BaseMapTileResourceType(MapTileResourceType):
    """Type of Base Map Tile Resources."""

    alabeltile = "alabeltile"
    basetile = "basetile"
    blinetile = "blinetile"
    labeltile = "labeltile"
    linetile = "linetile"
    lltile = "lltile"
    maptile = "maptile"
    streettile = "streettile"
    trucktile = "trucktile"
    truckonlytile = "truckonlytile"
    xbasetile = "xbasetile"
    trucknopttile = "trucknopttile"
    mapnopttile = "mapnopttile"

EVStationConnectorTypes

Bases: Enum

Defines the current connector types supported by the EV Charging Stations API.

Source code in herepy/here_enum.py
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
class EVStationConnectorTypes(Enum):
    """Defines the current connector types supported by the EV Charging Stations API."""

    unspecified = 0
    other = 1
    unallowed = 2
    small_paddle_inductive = 3
    large_paddle_inductive = 4
    nema_5_15 = 5
    nema_5_20 = 6
    bs_546_3_pin = 7
    cee_7_5 = 8
    cee_7_4_schuko = 9
    cee_7_7 = 10
    bs_1363__is_401_411__ms_58 = 11
    si_32 = 12
    as_nzs_3112 = 13
    cpcs_ccc = 14
    iram_2073 = 15
    sev_1011__t13 = 16
    sev_1011__t15 = 17
    sev_1011__t23 = 18
    sev_1011__t25 = 19
    section_107_2_d1 = 20
    thailand_tis_166_2549 = 21
    cei_23_16__VII = 22
    south_african_15_a__250_v = 23
    iec_60906_1_3_pin = 24
    avcon_connector = 25
    tesla_connector_high_power_wall = 26
    tesla_connector_universal_mobile = 27
    tesla_connector_spare_mobile = 28
    jevs_g_105 = 29
    iec_62196_2_type_1 = 30
    iec_62196_2_type_2_mennekes = 31
    iec_62196_2_type_3c = 32
    iec_62196_3_type_1_combo = 33
    iec_62196_3_type_2_combo = 34
    iec_60309_industrial_p_n_e = 35
    iec_60309_industrial_3p_e_n = 36
    iec_60309_industrial_2p_e_ac = 37
    iec_60309_industrial_p_n_e_ceeplus = 38
    iec_60309_industrial_3p_n_e = 39
    better_place_plug = 40
    marechal_plug = 41
    domestic_plug_socket_type_j = 42
    tesla_connector = 43
    iec_61851_1 = 44
    iec_62196_2_type_2_sae_j1772 = 45
    iec_60309_industrial_2p_e_dc = 46
    i_type_as__nz_3112 = 47
    domestic_plug_socket_type_a = 48
    domestic_plug_socket_type_c = 49

    def __str__(self):
        return "%s" % self._value_

FlowProximityAdditionalAttributes

Bases: Enum

Defines an additional attribute to be included in the traffic flow requests.

Source code in herepy/here_enum.py
331
332
333
334
335
336
337
338
class FlowProximityAdditionalAttributes(Enum):
    """Defines an additional attribute to be included in the traffic flow requests."""

    functional_class = "fc"
    shape = "sh"

    def __str__(self):
        return "%s" % self._value_

IncidentsCriticalityInt

Bases: Enum

Defines an attribute to be included in the traffic incidents requests.

Source code in herepy/here_enum.py
319
320
321
322
323
324
325
326
327
328
class IncidentsCriticalityInt(Enum):
    """Defines an attribute to be included in the traffic incidents requests."""

    critical = 0
    major = 1
    minor = 2
    lowImpact = 3

    def __int__(self):
        return self._value_

IncidentsCriticalityStr

Bases: Enum

Defines an attribute to be included in the traffic incidents requests.

Source code in herepy/here_enum.py
307
308
309
310
311
312
313
314
315
316
class IncidentsCriticalityStr(Enum):
    """Defines an attribute to be included in the traffic incidents requests."""

    critical = "critical"
    major = "major"
    minor = "minor"
    lowImpact = "lowImpact"

    def __str__(self):
        return "%s" % self._value_

IsolineRoutingMode

Bases: Enum

Defines an attribute which specifies optimization is applied during isoline calculation.

Source code in herepy/here_enum.py
341
342
343
344
345
346
347
348
class IsolineRoutingMode(Enum):
    """Defines an attribute which specifies optimization is applied during isoline calculation."""

    fast = "fast"
    short = "short"

    def __str__(self):
        return "%s" % self._value_

IsolineRoutingOptimizationMode

Bases: Enum

Mode of how isoline calculation is optimized.

Source code in herepy/here_enum.py
362
363
364
365
366
367
368
369
370
class IsolineRoutingOptimizationMode(Enum):
    """Mode of how isoline calculation is optimized."""

    quality = "quality"
    performance = "performance"
    balanced = "balanced"

    def __str__(self):
        return "%s" % self._value_

IsolineRoutingRangeType

Bases: Enum

Type of ranges how isoline calculation is optimized.

Source code in herepy/here_enum.py
373
374
375
376
377
378
379
380
381
class IsolineRoutingRangeType(Enum):
    """Type of ranges how isoline calculation is optimized."""

    distance = "distance"
    time = "time"
    consumption = "consumption"

    def __str__(self):
        return "%s" % self._value_

IsolineRoutingTransportMode

Bases: Enum

Mode of transport to be used for the calculation of the isolines.

Source code in herepy/here_enum.py
351
352
353
354
355
356
357
358
359
class IsolineRoutingTransportMode(Enum):
    """Mode of transport to be used for the calculation of the isolines."""

    car = "car"
    truck = "truck"
    pedestrian = "pedestrian"

    def __str__(self):
        return "%s" % self._value_

MapImageFormatType

Bases: Enum

Type of Map Image Formats

Source code in herepy/here_enum.py
474
475
476
477
478
479
480
481
482
class MapImageFormatType(Enum):
    """Type of Map Image Formats"""

    png = 0
    jpeg = 1
    gif = 2
    bmp = 3
    png8 = 4
    svg = 5

MapImageResourceType

Bases: Enum

Type of Map Image Resources

Source code in herepy/here_enum.py
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
class MapImageResourceType(Enum):
    """Type of Map Image Resources"""

    companylogo = "companylogo"
    heat = "heat"
    mapview = "mapview"
    region = "region"
    roadsign = "roadsign"
    route = "route"
    routing = "routing"
    stat = "stat"
    tiltmap = "tiltmap"
    turnpoint = "turnpoint"
    version = "version"

    def __str__(self):
        return "%s" % self._value_

MapTileApiType

Bases: Enum

Type of Map Tile Api.

Source code in herepy/here_enum.py
384
385
386
387
388
389
390
391
392
class MapTileApiType(Enum):
    """Type of Map Tile Api."""

    aerial = "aerial"
    base = "base"
    traffic = "traffic"

    def __str__(self):
        return "%s" % self._value_

MatrixRoutingMode

Bases: Enum

Optimization applied during route calculation of Matrix Routing API route.

Source code in herepy/here_enum.py
132
133
134
135
136
137
138
139
class MatrixRoutingMode(Enum):
    """Optimization applied during route calculation of Matrix Routing API route."""

    fast = "fast"
    short = "short"

    def __str__(self):
        return "%s" % self._value_

MatrixRoutingProfile

Bases: Enum

Defines profile IDs that enable the calculation of matrices with routes of arbitrary length.

Source code in herepy/here_enum.py
119
120
121
122
123
124
125
126
127
128
129
class MatrixRoutingProfile(Enum):
    """Defines profile IDs that enable the calculation of matrices with routes of arbitrary length."""

    car_fast = "carFast"
    car_short = "carShort"
    truck_fast = "truckFast"
    pedestrian = "pedestrian"
    bicycle = "bicycle"

    def __str__(self):
        return "%s" % self._value_

MatrixRoutingTransportMode

Bases: Enum

Defines transport modes on Matrix Routing API. Depending on the transport mode special constraints, speed attributes and weights are taken into account during route calculation.

Source code in herepy/here_enum.py
142
143
144
145
146
147
148
149
150
151
152
class MatrixRoutingTransportMode(Enum):
    """Defines transport modes on Matrix Routing API. Depending on the transport mode special constraints,
    speed attributes and weights are taken into account during route calculation."""

    car = "car"
    truck = "truck"
    pedestrian = "pedestrian"
    bicycle = "bicycle"

    def __str__(self):
        return "%s" % self._value_

MatrixRoutingType

Bases: Enum

Defines types of calculation of routing matrices.

Source code in herepy/here_enum.py
106
107
108
109
110
111
112
113
114
115
116
class MatrixRoutingType(Enum):
    """Defines types of calculation of routing matrices."""

    world = "world"
    circle = "circle"
    bounding_box = "boundingBox"
    polygon = "polygon"
    auto_circle = "autoCircle"

    def __str__(self):
        return "%s" % self._value_

MatrixSummaryAttribute

Bases: Enum

Defines an attribute to be included in the route matrix entries.

Source code in herepy/here_enum.py
 96
 97
 98
 99
100
101
102
103
class MatrixSummaryAttribute(Enum):
    """Defines an attribute to be included in the route matrix entries."""

    travel_times = "travelTimes"
    distances = "distances"

    def __str__(self):
        return "%s" % self._value_

MultiplePickupOfferType

Bases: Enum

Defines types of Fleet Telematics Api's pickup offers.

Source code in herepy/here_enum.py
297
298
299
300
301
302
303
304
class MultiplePickupOfferType(Enum):
    """Defines types of Fleet Telematics Api's pickup offers."""

    pickup = "pickup"
    drop = "drop"

    def __str__(self):
        return "%s" % self._value_

PlacesCategory

Bases: Enum

Categories which are used in places api functions.

Source code in herepy/here_enum.py
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
class PlacesCategory(Enum):
    """Categories which are used in places api functions."""

    accomodation = "accomodation"
    administrative_areas_buildings = "administrative-areas-buildings"
    airport = "airport"
    atm_bank_exchange = "atm-bank-exchange"
    coffee_tea = "coffee-tea"
    eat_drink = "eat-drink"
    going_out = "going-out"
    hospital_health_care_facility = "hospital-health-care-facility"
    leisure_outdoor = "leisure-outdoor"
    natural_geographical = "natural-geographical"
    petrol_station = "petrol-station"
    restaurant = "restaurant"
    snacks_fast_food = "snacks-fast-food"
    sights_museums = "sights-museums"
    shopping = "shopping"
    toilet_rest_area = "toilet-rest-area"
    transport = "transport"

    def __str__(self):
        return "%s" % self._value_

PublicTransitModeType

Bases: Enum

Mode types used in public transit api

Source code in herepy/here_enum.py
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
class PublicTransitModeType(Enum):
    """Mode types used in public transit api"""

    high_speed_train = 0
    intercity_train = 1
    inter_regional_train = 2
    regional_train = 3
    city_train = 4
    bus = 5
    ferry = 6
    subway = 7
    light_rail = 8
    private_bus = 9
    inclined = 10
    aerial = 11
    bus_rapid = 12
    monorail = 13
    flight = 14
    walk = 20

    def __str__(self):
        return "%s" % self._value_

PublicTransitRoutingMode

Bases: Enum

Routing types used in public transit api

Source code in herepy/here_enum.py
190
191
192
193
194
195
196
197
class PublicTransitRoutingMode(Enum):
    """Routing types used in public transit api"""

    schedule = "schedule"
    realtime = "realtime"

    def __str__(self):
        return "%s" % self._value_

PublicTransitSearchMethod

Bases: Enum

Search methods used in public transit search function

Source code in herepy/here_enum.py
180
181
182
183
184
185
186
187
class PublicTransitSearchMethod(Enum):
    """Search methods used in public transit search function"""

    fuzzy = "fuzzy"
    strict = "strict"

    def __str__(self):
        return "%s" % self._value_

RouteMode

Bases: Enum

Modes which is used in routing api functions.

Source code in herepy/here_enum.py
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
class RouteMode(Enum):
    """Modes which is used in routing api functions."""

    fastest = "fastest"
    shortest = "shortest"
    balanced = "balanced"
    bicycle = "bicycle"
    car = "car"
    car_hov = "carHOV"
    traffic_enabled = "traffic:enabled"
    traffic_disabled = "traffic:disabled"
    traffic_default = "traffic:default"
    enabled = "enabled"
    pedestrian = "pedestrian"
    publicTransport = "publicTransport"
    publicTransportTimeTable = "publicTransportTimeTable"
    truck = "truck"

    def __str__(self):
        return "%s" % self._value_

RoutingApiReturnField

Bases: Enum

Attributes are included in the response as part of data representation of a Route or Section..

Source code in herepy/here_enum.py
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
class RoutingApiReturnField(Enum):
    """Attributes are included in the response as part of data representation of a Route or Section.."""

    polyline = "polyline"
    actions = "actions"
    instructions = "instructions"
    summary = "summary"
    travelSummary = "travelSummary"
    mlDuration = "mlDuration"
    turnByTurnActions = "turnByTurnActions"
    elevation = "elevation"
    routeHandle = "routeHandle"
    passthrough = "passthrough"
    incidents = "incidents"
    routingZones = "routingZones"

    def __str__(self):
        return "%s" % self._value_

RoutingApiSpanField

Bases: Enum

Attributes are included in the response spans.

Source code in herepy/here_enum.py
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
class RoutingApiSpanField(Enum):
    """Attributes are included in the response spans."""

    walkAttributes = "walkAttributes"
    streetAttributes = "streetAttributes"
    carAttributes = "carAttributes"
    truckAttributes = "truckAttributes"
    scooterAttributes = "scooterAttributes"
    names = "names"
    length = "length"
    duration = "duration"
    baseDuration = "baseDuration"
    countryCode = "countryCode"
    functionalClass = "functionalClass"
    routeNumbers = "routeNumbers"
    speedLimit = "speedLimit"
    maxSpeed = "maxSpeed"
    dynamicSpeedInfo = "dynamicSpeedInfo"
    segmentId = "segmentId"
    segmentRef = "segmentRef"
    consumption = "consumption"
    routingZones = "routingZones"
    notices = "notices"

    def __str__(self):
        return "%s" % self._value_

RoutingMetric

Bases: Enum

Units of measurement used in guidance instructions.

Source code in herepy/here_enum.py
38
39
40
41
42
43
44
45
class RoutingMetric(Enum):
    """Units of measurement used in guidance instructions."""

    metric = "metric"
    imperial = "imperial"

    def __str__(self):
        return "%s" % self._value_

RoutingMode

Bases: Enum

Routing modes which is used in Routing API v8 functions.

Source code in herepy/here_enum.py
28
29
30
31
32
33
34
35
class RoutingMode(Enum):
    """Routing modes which is used in Routing API v8 functions."""

    fast = "fast"
    short = "short"

    def __str__(self):
        return "%s" % self._value_

RoutingTransportMode

Bases: Enum

Transport modes of Routing API v8

Source code in herepy/here_enum.py
485
486
487
488
489
490
491
492
493
494
495
496
497
class RoutingTransportMode(Enum):
    """Transport modes of Routing API v8"""

    car = "car"
    truck = "truck"
    pedestrian = "pedestrian"
    bicycle = "bicycle"
    scooter = "scooter"
    taxi = "taxi"
    bus = "bus"

    def __str__(self):
        return "%s" % self._value_

ShippedHazardousGood

Bases: Enum

Enum of hazardous materials in the vehicle.

Source code in herepy/here_enum.py
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
class ShippedHazardousGood(Enum):
    """Enum of hazardous materials in the vehicle."""

    explosive = "explosive"
    gas = "gas"
    flammable = "flammable"
    combustible = "combustible"
    organic = "organic"
    poison = "poison"
    radioactive = "radioactive"
    corrosive = "corrosive"
    poisonousInhalation = "poisonousInhalation"
    harmfulToWater = "harmfulToWater"
    other = "other"

    def __str__(self):
        return self._value_

TrafficMapTileResourceType

Bases: MapTileResourceType

Type of Traffic Map Tile Resources.

Source code in herepy/here_enum.py
436
437
438
439
440
441
442
class TrafficMapTileResourceType(MapTileResourceType):
    """Type of Traffic Map Tile Resources."""

    flowbasetile = "flowbasetile"
    flowlabeltile = "flowlabeltile"
    flowtile = "flowtile"
    traffictile = "traffictile"

TruckType

Bases: Enum

Specifies the type of truck.

Source code in herepy/here_enum.py
544
545
546
547
548
549
550
551
class TruckType(Enum):
    """Specifies the type of truck."""

    straight = "straight"
    tractor = "tractor"

    def __str__(self):
        return self._value_

TunnelCategory

Bases: Enum

Specifies the cargo tunnel restriction code.

Source code in herepy/here_enum.py
532
533
534
535
536
537
538
539
540
541
class TunnelCategory(Enum):
    """Specifies the cargo tunnel restriction code."""

    b = "B"
    c = "C"
    d = "D"
    e = "E"

    def __str__(self):
        return self._value_

VectorMapTileLayer

Bases: Enum

Type of Vector Map Tile Layer

Source code in herepy/here_enum.py
445
446
447
448
449
450
451
452
class VectorMapTileLayer(Enum):
    """Type of Vector Map Tile Layer"""

    base = "base"
    core = "core"

    def __str__(self):
        return "%s" % self._value_

WeatherProductType

Bases: Enum

Identifis the type of report to obtain.

Source code in herepy/here_enum.py
224
225
226
227
228
229
230
231
232
233
234
235
236
class WeatherProductType(Enum):
    """Identifis the type of report to obtain."""

    observation = "observation"
    forecast_7days = "forecast_7days"
    forecast_7days_simple = "forecast_7days_simple"
    forecast_hourly = "forecast_hourly"
    forecast_astronomy = "forecast_astronomy"
    alerts = "alerts"
    nws_alerts = "nws_alerts"

    def __str__(self):
        return "%s" % self._value_