Retrieve travel modes

GET

POST

Use dark colors for code blocksCopy
GET https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/retrieveTravelModes

GET

POST

Use dark colors for code blocksCopy
GET https://route-api.arcgis.com/arcgis/rest/services/World/ClosestFacility/NAServer/ClosestFacility_World/retrieveTravelModes

GET

POST

Use dark colors for code blocksCopy
GET https://route-api.arcgis.com/arcgis/rest/services/World/ServiceAreas/NAServer/ServiceArea_World/retrieveTravelModes

GET

POST

Use dark colors for code blocksCopy
GET https://route-api.arcgis.com/arcgis/rest/services/World/OriginDestinationCostMatrix/NAServer/OriginDestinationCostMatrix_World/retrieveTravelModes

Retrieve travel modes service is used to get the supported travel modes configured in your ArcGIS Online organization.

A travel mode is essentially a template consisting of a long list of travel settings that define the physical characteristics of a vehicle or pedestrian. Those characteristics are considered when performing a network analysis to define how the vehicle or pedestrian travels and where it can go. Selecting a predefined travel mode allows you to efficiently and consistently set a number of properties that are appropriate for the mode of travel you intend to model. The benefits are time savings and reduced complexity—you don't need to remember and configure, with each analysis, the parameter values that most accurately characterize the vehicles you're modeling.

An administrator of your organization can configure travel modes to change the properties of the default travel modes provided by ArcGIS Online, add new travel modes that better reflect your organization’s workflows, or remove travel modes that are not suitable for your organization’s workflows.

Learn more about configuring travel modes

Parameters

Name	Required	Type	Default	Description
`f`		`string`		The request response format, either `json` or `pjson`
`token`		`string`		An access token with the required privileges.

Required parameters

f

stringrequired

Values: json | pjson

The response format.

Use dark colors for code blocksCopy
f=json

token

stringrequired

An access token with the required privileges.

ArcGIS Location Platform: premium:user:networkanalysis:routing or premium:user:networkanalysis:optimizedrouting
ArcGIS Online: premium:user:networkanalysis

Use dark colors for code blocksCopy
token=<ACCESS_TOKEN>

To use HTTP headers instead of the token parameter, set the following:

X-Esri-Authorization

Authorization

Use dark colors for code blocksCopy

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.

Response details

You can make a request to retrieve travel modes using the following form:

Use dark colors for code blocksCopy
POST https://route-api.arcgis.com/arcgis/rest/services/World/Route/NAServer/Route_World/retrieveTravelModes? HTTP/1.1
Content-Type: application/x-www-form-urlencoded

token=<ACCESS_TOKEN>
&f=json

Use dark colors for code blocksCopy
{
  "currentVersion": 11.4,
  "defaultTravelMode": "FEgifRtFndKNcJMJ",
  "supportedTravelModes": [
    {
      "attributeParameterValues": [
        {
          "attributeName": "TravelTime",
          "parameterName": "Vehicle Maximum Speed (km/h)",
          "value": 0
        },
        {
          "attributeName": "Avoid Carpool Roads",
          "parameterName": "Restriction Usage",
          "value": "PROHIBITED"
        },
        {
          "attributeName": "Avoid Express Lanes",
          "parameterName": "Restriction Usage",
          "value": "PROHIBITED"
Expand

Use dark colors for code blocksCopy
{
  "error": {
    "code": "<code>",
    "message": "<message>",
    "details": ["<details>"]
  }
}