Skip To Content

GetWebToolInfo

Summary

Get information such as the description of the network dataset used for the analysis and the execution limits for a tool in the routing utility services registered with your portal.

Discussion

GetWebToolInfo allows you to get the tool limits or information for the network data source used by your portal.

Syntax

GetWebToolInfo (service_name, tool_name, {portal_url})
ParameterExplanationData Type
service_name

The name of the service containing the web tool.

Valid values are asyncClosestFacility, asyncLocationAllocation, asyncODCostMatrix, asyncRoute, asyncServiceArea, asyncVRP, and syncVRP. The values are case sensitive. If the service_name value is not in the list of supported values, a ValueError occurs.

String
tool_name

The name of the web tool.

Valid values are EditVehicleRoutingProblem, FindClosestFacilities, FindRoutes, GenerateOriginDestinationCostMatrix, GenerateServiceAreas, SolveLocationAllocation, and SolveVehicleRoutingProblem. The values are case sensitive. A ValueError occurs if the tool_name value is not in the list of supported values.

String
portal_url

The URL of the portal containing the service. If a value is not specified, the active portal URL will be used.

(The default value is None)

String
Return Value
Data TypeExplanation
Dictionary

KeysValues

networkDataset

Provides the information about the network dataset used by the web tool

serviceLimits

Provides the limits for the web tool

The GetWebToolInfo dictionary object keys.

Code sample

GetWebToolInfo example 1

The following code sample shows how to get the maximum number of facilities supported by the Service Area utility service from your active portal.

Missing source code file
GetWebToolInfo example 2

The following code sample shows how to print the traffic support type for all the cost attributes from your network data source.

Missing source code file