/SnapToRoads

points

Specify the points that you want to snap to the road the vehicle is most likely traveling along. The points can be the GPS points from a navigation device, the tracks captured using ArcGIS Field Maps, or some other set of points that were collected while driving the vehicle.

The distance between the points will affect the performance and final quality of the output. If the points are close together, the algorithm will have a better chance of deducing the probable roads at the expense of processing time. Fewer points will process faster, but may result in the route that was deduced potentially taking different roads.

Example:

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
{
  "features": [
    {
      "attributes": {
        "OBJECTID": 1,
        "location_timestamp": 1704522159000,
        "track_id": "track 1"
      },
      "geometry": {
        "x": -122.43410099956145,
        "y": 37.800155000053394
      }
    },
    {
      "attributes": {
        "OBJECTID": 2,
        "location_timestamp": 1704522171000,
        "track_id": "track 1"
      },
      "geometry": {

f

The response format.

1
f=json

token

An access token with the required privileges.

• ArcGIS Location Platform: premium:user:networkanalysis:snaptoroads
• ArcGIS Online: premium:user:networkanalysis

1
token=<ACCESS_TOKEN>

1
2
3
4

GET <SERVICE_REQUEST> HTTP/1.1
  Host: <SERVICE_DOMAIN>
  X-Esri-Authorization: Bearer <ACCESS_TOKEN>

Learn more about access tokens and privileges in the Security and authentication developer guide.

travel_mode

Choose the mode of transportation for the analysis. This is the mode of transportation that matches the track data you are analyzing.

The snap to roads algorithms use the travel mode settings when determining the most likely roads that were traveled. For example, if the travel mode restricts travel on express lanes, the algorithms attempt to return roads that are not express lanes. However, in cases where the track clearly indicates the use of an express lane, the algorithms return the express lane regardless of the restriction setting. In other words, the travel mode settings are used as a guideline to influence the snapping behavior, but they may be overridden when the track data does not match those settings.

To learn more about travel modes, see Configure travel modes

return_lines

Specify whether or not the service will return output_lines representing the roads traversed.

• true—The output_lines will be returned.
• false—The output_lines will not be returned.

road_properties_on_snapped_points

Allowed values:

• length_kilometers: The length of the road segment the snapped points locate on in kilometers.
• length_miles: The length of the road segment the snapped points locate on in miles.
• posted_speed_limit_kph: The posted speed limit of the road segment the snapped points locate on in kilometers per hour.
• posted_speed_limit_mph: The posted speed limit of the road segment the snapped points locate on in miles per hour.
• posted_speed_limit_mps: The posted speed limit of the road segment the snapped points locate on in meters per second.
• posted_truck_speed_limit_kph: The posted truck speed limit of the road segment the snapped points locate on in kilometers per hour.
• posted_truck_speed_limit_mph: The posted truck speed limit of the road segment the snapped points locate on in miles per hour.
• posted_truck_speed_limit_mps: The posted truck speed limit of the road segment the snapped points locate on in meters per second.

Specify the road properties that the service should return on the output_snapped_points output.

For example: road_properties_on_snapped_points=["posted_speed_limit_kph", "posted_truck_speed_limit_kph"]

road_properties_on_lines

Allowed values:

• length_kilometers: The length of the road segment in kilometers.
• length_miles: The length of the road segment the in miles.
• posted_speed_limit_kph: The posted speed limit of the road segment in kilometers per hour.
• posted_speed_limit_mph: The posted speed limit of the road segment in miles per hour.
• posted_speed_limit_mps: The posted speed limit of the road segment in meters per second.
• posted_truck_speed_limit_kph: The posted truck speed limit of the road segment in kilometers per hour.
• posted_truck_speed_limit_mph: The posted truck speed limit of the road segment in miles per hour.
• posted_truck_speed_limit_mps: The posted truck speed limit of the road segment in meters per second.

Specify the road properties that the service should return on the output_lines output.

For example: road_properties_on_lines=["length_miles", "length_kilometers"]

analysis_region

Allowed values: Europe, Japan, Korea, MiddleEastAndAfrica, NorthAmerica, SouthAmerica, SouthAsia, Thailand

Specify the region in which to perform the analysis. If a value is not specified for this parameter, the service will automatically calculate the region name based on the location of the input points. Setting the name of the region is recommended to speed up the analysis.

The data coverage page lists the countries that are grouped into each of these regions.

context

This parameter contains additional settings that affect task operation, for example, the spatial reference of the output features.

overrides

output_snapped_points

This output is always returned. It includes all of the fields from the input specified in the points parameter plus any fields for the properties specified in the road_properties_on_snapped_points parameter. The output also contains following attributes that are either generated or altered by the service.

output_lines

This output is returned if return_lines is specified as true in the input. It includes fields for the properties specified in the road_properties_on_lines parameter. The output also contains following attributes that are generated by the service.

usage_cost

This parameter returns the credits used by the analysis.