Skip to content

Fleet Telematics API

A python interface into the HERE Fleet Telematics API.

FleetTelematicsApi

Bases: HEREApi

A python interface into the HERE Fleet Telematics API.

Source code in src/herepy/fleet_telematics_api.py 
 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
class FleetTelematicsApi(HEREApi):
    """A python interface into the HERE Fleet Telematics API."""

    def __init__(self, api_key: str = None, timeout: int = None):
        """
        Initialize a FleetTelematicsApi instance.

        Args:
          api_key (str):
            API key taken from HERE Developer Portal.
          timeout (int):
            Timeout limit for requests.

        Returns:
          FleetTelematicsApi instance.

        """
        super().__init__(api_key, timeout)
        self._base_url = "https://wse.ls.hereapi.com/2/"

    def __create_find_sequence_parameters(
        self,
        start: str,
        departure: str,
        intermediate_destinations: list[str],
        end: str,
        modes: list[RouteMode],
    ):
        data = {
            "apiKey": self._api_key,
            "start": start.__str__(),
            "departure": departure,
        }

        count = 0
        for destination_param in intermediate_destinations:
            count += 1
            data[str.format("destination{0}", count)] = destination_param

        data["end"] = end
        data["improveFor"] = "time"
        data["departure"] = "now"

        modes_str = ""
        for route_mode in modes:
            modes_str += route_mode.__str__() + ";"

        data["mode"] = modes_str
        return data

    def __create_find_pickup_parameters(
        self,
        modes: list[RouteMode],
        start: str,
        departure: str,
        capacity: int,
        vehicle_cost: float,
        driver_cost: int,
        max_detour: int,
        rest_times: str,
        end: str,
        intermediate_destinations: list[str],
    ):
        data: dict[str, str | int | float] = {}

        modes_str = ""
        for route_mode in modes:
            modes_str += route_mode.__str__() + ";"
        modes_str = modes_str[:-1]
        data["mode"] = modes_str
        data["start"] = "waypoint0;" + start
        data["departure"] = departure
        data["capacity"] = capacity
        data["vehicleCost"] = vehicle_cost
        data["driverCost"] = driver_cost
        data["maxDetour"] = max_detour
        data["restTimes"] = rest_times

        count = 0
        for destination_pickup_param in intermediate_destinations:
            data[str.format("destination{0}", count)] = str.format("waypoint{0};", count + 1) + destination_pickup_param
            count += 1

        data["end"] = str.format("waypoint{0};{1}", count + 1, end)
        return data

    def __get(self, base_url, data, response_cls):
        url = Utils.build_url(base_url, extra_params=data)
        response = requests.get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get("results") is not None:
            return response_cls.new_from_jsondict(json_data)
        else:
            raise error_from_fleet_telematics_service_error(json_data)

    def find_sequence(
        self,
        start: str,
        departure: str,
        intermediate_destinations: list[str],
        end: str,
        modes: list[RouteMode],
    ) -> WaypointSequenceResponse | None:
        """
        Find time-optimized waypoint sequence route.

        Args:
          start (str):
            Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          departure (str):
            Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
          intermediate_destinations (List[str]):
            Intermediate points between start and end points. List of `str.format('{0};{1},{2}', text, latitude, longitude)`.
          end (str):
            End point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          modes (List[RouteMode]):
            Route modes.

        Returns:
          WaypointSequenceResponse
        Raises:
          HEREError

        """
        data = self.__create_find_sequence_parameters(
            start=start,
            departure=departure,
            intermediate_destinations=intermediate_destinations,
            end=end,
            modes=modes,
        )
        response = self.__get(self._base_url + "findsequence.json", data, WaypointSequenceResponse)
        return response

    def find_pickups(
        self,
        modes: list[RouteMode],
        start: str,
        departure: str,
        capacity: int,
        vehicle_cost: float,
        driver_cost: int,
        max_detour: int,
        rest_times: str,
        intermediate_destinations: list[str],
        end: str,
    ) -> WaypointSequenceResponse | None:
        """
        Find cheaper route by picking up some additional goods along the route.

        Args:
          modes (List[RouteMode]):
            Route modes.
          start (str):
            Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          departure (str):
            Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
          capacity (int):
            Amount of payload the vehicle including trailers can carry, volume and/or weight.
            No unit is specified, but the value must be in the same unit as the waypoint pickup load values.
          vehicle_cost (float):
            Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and
            the waypoint drop-off values.
          driver_cost (int):
            Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and
            the waypoint drop-off values.
          max_detour (int):
            Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time
            without picking up anything.
          rest_times (str):
            The parameter restTimes can be set to
            `disabled`
               rest times are not considered. This is equivalent to omitting the parameter restTimes
            `default`
               Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest.
            `durations:...` and `serviceTimes:...`
               You can provide values for driving and rest periods and define if service times at waypoints
               can be used for resting. You must provide both parameters.
          intermediate_destinations (List[DestinationPickupParam]):
            Intermediate destinations, at least one. If no end parameter is provided, one of these values is
            selected as end of the sequence.
            `str.format('{0},{1};{2}:{3},value:{4}', latitude,
                  longitude, param_type,
                  item, value)`
            or
            `str.format('{0},{1};{2}:{3}', latitude, longitude,
                  param_type, item)`
          end (str):
            End of the journey. `str.format('{0};{1},{2}', text, latitude, longitude)`

        Returns:
          WaypointSequenceResponse
        Raises:
          HEREError

        """
        data = self.__create_find_pickup_parameters(
            modes=modes,
            start=start,
            departure=departure,
            capacity=capacity,
            vehicle_cost=vehicle_cost,
            driver_cost=driver_cost,
            max_detour=max_detour,
            rest_times=rest_times,
            intermediate_destinations=intermediate_destinations,
            end=end,
        )
        response = self.__get(self._base_url + "findpickups.json", data, WaypointSequenceResponse)
        return response

    async def __get_async(self, base_url, data, response_cls):
        url = Utils.build_url(base_url, extra_params=data)
        response = await self._get_async_client().get(url, timeout=self._timeout)
        json_data = json.loads(response.content.decode("utf8"))
        if json_data.get("results") is not None:
            return response_cls.new_from_jsondict(json_data)
        else:
            raise error_from_fleet_telematics_service_error(json_data)

    async def async_find_sequence(
        self,
        start: str,
        departure: str,
        intermediate_destinations: list[str],
        end: str,
        modes: list[RouteMode],
    ) -> WaypointSequenceResponse | None:
        """
        Find time-optimized waypoint sequence route.

        Args:
          start (str):
            Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          departure (str):
            Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
          intermediate_destinations (List[str]):
            Intermediate points between start and end points. List of `str.format('{0};{1},{2}', text, latitude, longitude)`.
          end (str):
            End point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          modes (List[RouteMode]):
            Route modes.

        Returns:
          WaypointSequenceResponse
        Raises:
          HEREError

        """
        data = self.__create_find_sequence_parameters(
            start=start,
            departure=departure,
            intermediate_destinations=intermediate_destinations,
            end=end,
            modes=modes,
        )
        response = await self.__get_async(self._base_url + "findsequence.json", data, WaypointSequenceResponse)
        return response

    async def async_find_pickups(
        self,
        modes: list[RouteMode],
        start: str,
        departure: str,
        capacity: int,
        vehicle_cost: float,
        driver_cost: int,
        max_detour: int,
        rest_times: str,
        intermediate_destinations: list[str],
        end: str,
    ) -> WaypointSequenceResponse | None:
        """
        Find cheaper route by picking up some additional goods along the route.

        Args:
          modes (List[RouteMode]):
            Route modes.
          start (str):
            Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
          departure (str):
            Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
          capacity (int):
            Amount of payload the vehicle including trailers can carry, volume and/or weight.
            No unit is specified, but the value must be in the same unit as the waypoint pickup load values.
          vehicle_cost (float):
            Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and
            the waypoint drop-off values.
          driver_cost (int):
            Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and
            the waypoint drop-off values.
          max_detour (int):
            Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time
            without picking up anything.
          rest_times (str):
            The parameter restTimes can be set to
            `disabled`
               rest times are not considered. This is equivalent to omitting the parameter restTimes
            `default`
               Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest.
            `durations:...` and `serviceTimes:...`
               You can provide values for driving and rest periods and define if service times at waypoints
               can be used for resting. You must provide both parameters.
          intermediate_destinations (List[DestinationPickupParam]):
            Intermediate destinations, at least one. If no end parameter is provided, one of these values is
            selected as end of the sequence.
            `str.format('{0},{1};{2}:{3},value:{4}', latitude,
                  longitude, param_type,
                  item, value)`
            or
            `str.format('{0},{1};{2}:{3}', latitude, longitude,
                  param_type, item)`
          end (str):
            End of the journey. `str.format('{0};{1},{2}', text, latitude, longitude)`

        Returns:
          WaypointSequenceResponse
        Raises:
          HEREError

        """
        data = self.__create_find_pickup_parameters(
            modes=modes,
            start=start,
            departure=departure,
            capacity=capacity,
            vehicle_cost=vehicle_cost,
            driver_cost=driver_cost,
            max_detour=max_detour,
            rest_times=rest_times,
            intermediate_destinations=intermediate_destinations,
            end=end,
        )
        response = await self.__get_async(self._base_url + "findpickups.json", data, WaypointSequenceResponse)
        return response

__init__(api_key=None, timeout=None)

Initialize a FleetTelematicsApi instance.

Parameters:

Name Type Description Default
api_key str

API key taken from HERE Developer Portal.

 None
timeout int

Timeout limit for requests.

 None

Returns:

Type Description

FleetTelematicsApi instance.
Source code in src/herepy/fleet_telematics_api.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
def __init__(self, api_key: str = None, timeout: int = None):
    """
    Initialize a FleetTelematicsApi instance.

    Args:
      api_key (str):
        API key taken from HERE Developer Portal.
      timeout (int):
        Timeout limit for requests.

    Returns:
      FleetTelematicsApi instance.

    """
    super().__init__(api_key, timeout)
    self._base_url = "https://wse.ls.hereapi.com/2/"

async_find_pickups(modes, start, departure, capacity, vehicle_cost, driver_cost, max_detour, rest_times, intermediate_destinations, end) async

Find cheaper route by picking up some additional goods along the route.

Parameters:

Name Type Description Default
modes List[RouteMode]

Route modes.

 required
start str

Starting point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
departure str

Time when travel is expected to start. The format is as xsd type xs:datetime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]

 required
capacity int

Amount of payload the vehicle including trailers can carry, volume and/or weight. No unit is specified, but the value must be in the same unit as the waypoint pickup load values.

 required
vehicle_cost float

Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and the waypoint drop-off values.

 required
driver_cost int

Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and the waypoint drop-off values.

 required
max_detour int

Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time without picking up anything.

 required
rest_times str

The parameter restTimes can be set to disabled rest times are not considered. This is equivalent to omitting the parameter restTimes default Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest. durations:... and serviceTimes:... You can provide values for driving and rest periods and define if service times at waypoints can be used for resting. You must provide both parameters.

 required
intermediate_destinations List[DestinationPickupParam]

Intermediate destinations, at least one. If no end parameter is provided, one of these values is selected as end of the sequence. str.format('{0},{1};{2}:{3},value:{4}', latitude, longitude, param_type, item, value) or str.format('{0},{1};{2}:{3}', latitude, longitude, param_type, item)

 required
end str

End of the journey. str.format('{0};{1},{2}', text, latitude, longitude)

 required

Returns:

Type Description
WaypointSequenceResponse | None

WaypointSequenceResponse

Raises: HEREError

Source code in src/herepy/fleet_telematics_api.py 
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
async def async_find_pickups(
    self,
    modes: list[RouteMode],
    start: str,
    departure: str,
    capacity: int,
    vehicle_cost: float,
    driver_cost: int,
    max_detour: int,
    rest_times: str,
    intermediate_destinations: list[str],
    end: str,
) -> WaypointSequenceResponse | None:
    """
    Find cheaper route by picking up some additional goods along the route.

    Args:
      modes (List[RouteMode]):
        Route modes.
      start (str):
        Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      departure (str):
        Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
      capacity (int):
        Amount of payload the vehicle including trailers can carry, volume and/or weight.
        No unit is specified, but the value must be in the same unit as the waypoint pickup load values.
      vehicle_cost (float):
        Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and
        the waypoint drop-off values.
      driver_cost (int):
        Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and
        the waypoint drop-off values.
      max_detour (int):
        Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time
        without picking up anything.
      rest_times (str):
        The parameter restTimes can be set to
        `disabled`
           rest times are not considered. This is equivalent to omitting the parameter restTimes
        `default`
           Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest.
        `durations:...` and `serviceTimes:...`
           You can provide values for driving and rest periods and define if service times at waypoints
           can be used for resting. You must provide both parameters.
      intermediate_destinations (List[DestinationPickupParam]):
        Intermediate destinations, at least one. If no end parameter is provided, one of these values is
        selected as end of the sequence.
        `str.format('{0},{1};{2}:{3},value:{4}', latitude,
              longitude, param_type,
              item, value)`
        or
        `str.format('{0},{1};{2}:{3}', latitude, longitude,
              param_type, item)`
      end (str):
        End of the journey. `str.format('{0};{1},{2}', text, latitude, longitude)`

    Returns:
      WaypointSequenceResponse
    Raises:
      HEREError

    """
    data = self.__create_find_pickup_parameters(
        modes=modes,
        start=start,
        departure=departure,
        capacity=capacity,
        vehicle_cost=vehicle_cost,
        driver_cost=driver_cost,
        max_detour=max_detour,
        rest_times=rest_times,
        intermediate_destinations=intermediate_destinations,
        end=end,
    )
    response = await self.__get_async(self._base_url + "findpickups.json", data, WaypointSequenceResponse)
    return response

async_find_sequence(start, departure, intermediate_destinations, end, modes) async

Find time-optimized waypoint sequence route.

Parameters:

Name Type Description Default
start str

Starting point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
departure str

Time when travel is expected to start. The format is as xsd type xs:datetime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]

 required
intermediate_destinations List[str]

Intermediate points between start and end points. List of str.format('{0};{1},{2}', text, latitude, longitude).

 required
end str

End point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
modes List[RouteMode]

Route modes.

 required

Returns:

Type Description
WaypointSequenceResponse | None

WaypointSequenceResponse

Raises: HEREError

Source code in src/herepy/fleet_telematics_api.py 
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
async def async_find_sequence(
    self,
    start: str,
    departure: str,
    intermediate_destinations: list[str],
    end: str,
    modes: list[RouteMode],
) -> WaypointSequenceResponse | None:
    """
    Find time-optimized waypoint sequence route.

    Args:
      start (str):
        Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      departure (str):
        Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
      intermediate_destinations (List[str]):
        Intermediate points between start and end points. List of `str.format('{0};{1},{2}', text, latitude, longitude)`.
      end (str):
        End point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      modes (List[RouteMode]):
        Route modes.

    Returns:
      WaypointSequenceResponse
    Raises:
      HEREError

    """
    data = self.__create_find_sequence_parameters(
        start=start,
        departure=departure,
        intermediate_destinations=intermediate_destinations,
        end=end,
        modes=modes,
    )
    response = await self.__get_async(self._base_url + "findsequence.json", data, WaypointSequenceResponse)
    return response

find_pickups(modes, start, departure, capacity, vehicle_cost, driver_cost, max_detour, rest_times, intermediate_destinations, end)

Find cheaper route by picking up some additional goods along the route.

Parameters:

Name Type Description Default
modes List[RouteMode]

Route modes.

 required
start str

Starting point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
departure str

Time when travel is expected to start. The format is as xsd type xs:datetime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]

 required
capacity int

Amount of payload the vehicle including trailers can carry, volume and/or weight. No unit is specified, but the value must be in the same unit as the waypoint pickup load values.

 required
vehicle_cost float

Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and the waypoint drop-off values.

 required
driver_cost int

Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and the waypoint drop-off values.

 required
max_detour int

Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time without picking up anything.

 required
rest_times str

The parameter restTimes can be set to disabled rest times are not considered. This is equivalent to omitting the parameter restTimes default Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest. durations:... and serviceTimes:... You can provide values for driving and rest periods and define if service times at waypoints can be used for resting. You must provide both parameters.

 required
intermediate_destinations List[DestinationPickupParam]

Intermediate destinations, at least one. If no end parameter is provided, one of these values is selected as end of the sequence. str.format('{0},{1};{2}:{3},value:{4}', latitude, longitude, param_type, item, value) or str.format('{0},{1};{2}:{3}', latitude, longitude, param_type, item)

 required
end str

End of the journey. str.format('{0};{1},{2}', text, latitude, longitude)

 required

Returns:

Type Description
WaypointSequenceResponse | None

WaypointSequenceResponse

Raises: HEREError

Source code in src/herepy/fleet_telematics_api.py 
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
def find_pickups(
    self,
    modes: list[RouteMode],
    start: str,
    departure: str,
    capacity: int,
    vehicle_cost: float,
    driver_cost: int,
    max_detour: int,
    rest_times: str,
    intermediate_destinations: list[str],
    end: str,
) -> WaypointSequenceResponse | None:
    """
    Find cheaper route by picking up some additional goods along the route.

    Args:
      modes (List[RouteMode]):
        Route modes.
      start (str):
        Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      departure (str):
        Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
      capacity (int):
        Amount of payload the vehicle including trailers can carry, volume and/or weight.
        No unit is specified, but the value must be in the same unit as the waypoint pickup load values.
      vehicle_cost (float):
        Cost per kilometer. No currency is specified, but the value must be in the same currency as the driverCost and
        the waypoint drop-off values.
      driver_cost (int):
        Cost per hour. No currency is specified, but the value must be in the same currency as the vehicleCost and
        the waypoint drop-off values.
      max_detour (int):
        Overall maximum additional seconds spent to pickup and drop-off items along the route, compared to the time
        without picking up anything.
      rest_times (str):
        The parameter restTimes can be set to
        `disabled`
           rest times are not considered. This is equivalent to omitting the parameter restTimes
        `default`
           Use internal default. The default are simplified European rules: After 4.5h driving 45min rest and after 9h driving 11h rest.
        `durations:...` and `serviceTimes:...`
           You can provide values for driving and rest periods and define if service times at waypoints
           can be used for resting. You must provide both parameters.
      intermediate_destinations (List[DestinationPickupParam]):
        Intermediate destinations, at least one. If no end parameter is provided, one of these values is
        selected as end of the sequence.
        `str.format('{0},{1};{2}:{3},value:{4}', latitude,
              longitude, param_type,
              item, value)`
        or
        `str.format('{0},{1};{2}:{3}', latitude, longitude,
              param_type, item)`
      end (str):
        End of the journey. `str.format('{0};{1},{2}', text, latitude, longitude)`

    Returns:
      WaypointSequenceResponse
    Raises:
      HEREError

    """
    data = self.__create_find_pickup_parameters(
        modes=modes,
        start=start,
        departure=departure,
        capacity=capacity,
        vehicle_cost=vehicle_cost,
        driver_cost=driver_cost,
        max_detour=max_detour,
        rest_times=rest_times,
        intermediate_destinations=intermediate_destinations,
        end=end,
    )
    response = self.__get(self._base_url + "findpickups.json", data, WaypointSequenceResponse)
    return response

find_sequence(start, departure, intermediate_destinations, end, modes)

Find time-optimized waypoint sequence route.

Parameters:

Name Type Description Default
start str

Starting point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
departure str

Time when travel is expected to start. The format is as xsd type xs:datetime [-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]

 required
intermediate_destinations List[str]

Intermediate points between start and end points. List of str.format('{0};{1},{2}', text, latitude, longitude).

 required
end str

End point. str.format('{0};{1},{2}', text, latitude, longitude)

 required
modes List[RouteMode]

Route modes.

 required

Returns:

Type Description
WaypointSequenceResponse | None

WaypointSequenceResponse

Raises: HEREError

Source code in src/herepy/fleet_telematics_api.py 
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
def find_sequence(
    self,
    start: str,
    departure: str,
    intermediate_destinations: list[str],
    end: str,
    modes: list[RouteMode],
) -> WaypointSequenceResponse | None:
    """
    Find time-optimized waypoint sequence route.

    Args:
      start (str):
        Starting point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      departure (str):
        Time when travel is expected to start. The format is as xsd type xs:datetime `[-]CCYY-MM-DDThh:mm:ss[Z|(+|-)hh:mm]`
      intermediate_destinations (List[str]):
        Intermediate points between start and end points. List of `str.format('{0};{1},{2}', text, latitude, longitude)`.
      end (str):
        End point. `str.format('{0};{1},{2}', text, latitude, longitude)`
      modes (List[RouteMode]):
        Route modes.

    Returns:
      WaypointSequenceResponse
    Raises:
      HEREError

    """
    data = self.__create_find_sequence_parameters(
        start=start,
        departure=departure,
        intermediate_destinations=intermediate_destinations,
        end=end,
        modes=modes,
    )
    response = self.__get(self._base_url + "findsequence.json", data, WaypointSequenceResponse)
    return response

UnauthorizedError

Bases: HEREError

Unauthorized Error Type.

This error is returned if the specified token was invalid or no contract could be found for this token.

Source code in src/herepy/fleet_telematics_api.py 
354
355
356
357
358
359
360
class UnauthorizedError(HEREError):
    """
    Unauthorized Error Type.

    This error is returned if the specified token was invalid or no contract
    could be found for this token.
    """

error_from_fleet_telematics_service_error(json_data)

Return the correct subclass for sequence errors.

Source code in src/herepy/fleet_telematics_api.py 
363
364
365
366
367
368
369
370
371
372
def error_from_fleet_telematics_service_error(json_data: dict):
    """Return the correct subclass for sequence errors."""
    if "error" in json_data:
        error_type = json_data["error"]
        message = json_data["error_description"]

        if error_type == "Unauthorized":
            return UnauthorizedError(message)
    # pylint: disable=W0212
    return HEREError("Error occurred on " + sys._getframe(1).f_code.co_name)