GetTravelModes operation

The Utilities service contains operations that provide auxiliary information for working with routing services available with ArcGIS Online. The Utilities service contains two operations, GetTravelModes and GetToolInfo. The GetTravelModes operation returns a list of travel modes configured for your organization that can be used with routing services. A travel mode represents a means of transportation, such as driving or walking. Travel modes essentially templates consisting of a long list of travel settings.

The GetTravelModes operation is meant to be used by different applications to display the name and, optionally, the description of the available travel modes in their user experience. 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.

Warning

When the operation is called using a token obtained through application logins, it always returns the default travel modes even if your organization has customized the travel modes. To get the travel modes from your organization, call this operation using a token obtained through a named user login. To run this operation in scenarios where you do not want the end users of your application to provide any credentials, you can use the following workflows:

Add the Utilities service (which contains the GetTravelModes operation) as an ArcGIS Server web service item using its REST URL (https://route.arcgis.com/arcgis/rest/services/World/Utilities/GPServer ) and storing your named user credentials with the service item. You can then call the GetTravelModes operation using the new URL provided by the service item. For example, after you add the web service item, the new URL to call GetTravelModes operation will be of the following form: https://utility.arcgis.com/usrsvcs/servers/<itemId>/rest/services/World/Utilities/GPServer/GetTravelModes/execute?parameters .
Use a self-hosted proxy service. For the proxy configuration, set the Utilities service REST URL as the value for the url property and the named user credentials for the username and password properties.

Required parameters

The GetTravelModes operation takes the token and f parameters, which are both required.

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

The request to GetTravelModes returns a JSON response that contains any warning messages from the service execution as well as an array of results. Each result in this array contains the value for the output parameters, supportedTravelModes and defaultTravelMode . If the request fails to execute, the response only contains the error property that contains the error messages.

For a list of error codes and details, go to Direct request error codes

You can make a request to the GetTravelModes operation from the Utilities service using the URL of the following form

POST
Use dark colors for code blocksCopy
POST https://route-api.arcgis.com/arcgis/rest/services/World/Utilities/GPServer/GetTravelModes/execute? HTTP/1.1
Content-Type: application/x-www-form-urlencoded

token=<ACCESS_TOKEN>
&f=json

Use dark colors for code blocksCopy
{
  "results": [
    {
      "paramName": "<paramName1>",
      "dataType": "<dataType1>",
      "value": "<valueLiteralOrObject1>"
    },
    {
      "paramName": "<paramName2>",
      "dataType": "<dataType2>",
      "value": "<valueLiteralOrObject2>"
    }
  ],
  "messages": [
    {
      "type": "<type1>",
      "description": "<description1>"
    },
    {
      "type": "<type2>",
Expand

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

Upon successful completion, the service returns a list of supported travel modes and the default travel mode as the output parameters described below:

supportedTravelModes

stringoptional

Use this parameter to a get a list of travel modes supported by your organization.

The following provides a description of fields that are returned for each travel mode:

ObjectID—A unique identifier for the travel mode. This identifier is automatically generated by the service.
Name—The name of the travel mode. This field can include the localized travel mode name and cannot be used to uniquely identify a travel mode based on its name. Use the AltName field for this instead.
TravelModeId—A unique identifier for the travel mode. This identifier is created every time a new travel mode is added but remains the same for existing travel modes.
TravelMode—The travel mode setting for a given travel mode. The value is a string representing a JSON object. When calling the routing services, you must convert this string into a JSON object using your API.
AltName—The name of the travel mode that does not change based on the profile language of the signed in user. This value can be used to uniquely identify a travel mode based on its name, unlike the Name field.

The following shows an example of the supportedTravelModes parameter.

Example:

Use dark colors for code blocksCopy
{
  "paramName": "supportedTravelModes",
  "dataType": "GPRecordSet",
  "value": {
    "displayFieldName": "",
    "fields": [
      {
        "name": "ObjectID",
        "type": "esriFieldTypeOID",
        "alias": "ObjectID"
      },
      {
        "name": "Name",
        "type": "esriFieldTypeString",
        "alias": "Travel Mode Name",
        "length": 255
      },
      {
        "name": "TravelModeId",
        "type": "esriFieldTypeString",
Expand

defaultTravelMode

stringoptional

Use this parameter to get the default travel mode to be used by the user interface of your application. The value property returns the travel mode ID that corresponds to the TravelModeId property of the attributes objects returned by the supportedTravelModes output parameter.

The following shows an example of the defaultTravelMode parameter:

Example:

Use dark colors for code blocksCopy
{
  "paramName": "defaultTravelMode",
  "dataType": "GPString",
  "value": "FEgifRtFndKNcJMJ"
}

Examples

Get a list of supported travel modes when the user profile language is English

In this example, you will get a list of all the travel modes that are supported in your ArcGIS Online organization. The language of the signed in user is English. The Name and AltName fields for travel modes have identical values.

Use dark colors for code blocksCopy
POST https://route-api.arcgis.com/arcgis/rest/services/World/Utilities/GPServer/GetTravelModes/execute? HTTP/1.1
Content-Type: application/x-www-form-urlencoded

token=<ACCESS_TOKEN>
&f=pjson

Use dark colors for code blocksCopy
{
  "results": [
    {
      "paramName": "supportedTravelModes",
      "dataType": "GPRecordSet",
      "value": {
        "displayFieldName": "",
        "fields": [
          {
            "name": "ObjectID",
            "type": "esriFieldTypeOID",
            "alias": "ObjectID"
          },
          {
            "name": "Name",
            "type": "esriFieldTypeString",
            "alias": "Travel Mode Name",
            "length": 255
          },
          {
Expand

Get a list of supported travel modes when the user profile language is Spanish

In this example, you will get a list of all the travel modes that are supported in your ArcGIS Online organization. The language of the signed in user is Spanish. The Name field provides the travel mode name in Spanish, and the AltName field provides the travel mode name in English. Regardless of the user profile language, the AltName field always provides the travel mode name in English.

Use dark colors for code blocksCopy
POST https://route-api.arcgis.com/arcgis/rest/services/World/Utilities/GPServer/GetTravelModes/execute? HTTP/1.1
Content-Type: application/x-www-form-urlencoded

token=<ACCESS_TOKEN>
&f=pjson

Use dark colors for code blocksCopy
{
  "results": [
    {
      "paramName": "supportedTravelModes",
      "dataType": "GPRecordSet",
      "value": {
        "displayFieldName": "",
        "fields": [
          {
            "name": "ObjectID",
            "type": "esriFieldTypeOID",
            "alias": "ObjectID"
          },
          {
            "name": "Name",
            "type": "esriFieldTypeString",
            "alias": "Travel Mode Name",
            "length": 255
          },
          {
Expand